Skip to content

Internal Refactoring v1.0 #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Apr 11, 2025
Merged

Internal Refactoring v1.0 #55

merged 23 commits into from
Apr 11, 2025

Conversation

ryangjchandler
Copy link
Collaborator

@ryangjchandler ryangjchandler commented Mar 27, 2025

There are a tonne of things that I've not been happy with internally.

Phiki is a rather large piece of machinery and TextMate tokenisation is a complex beast, so I think now is a good time to really nail down the internal APIs and get things into a more maintainable state.

This is going to be a progressive task that I'll aim to get done over the next few weeks as there are various bugs or missing features in the package right now that need resolving. To be honest, the internals are becoming rather convoluted and messy which makes fixing these things that bit more difficult.

If I'm struggling to find and fix things, nobody has a chance!


There are technically going to be breaking changes in this PR. I'm now marking certain parts of the API as @internal which means they do not adhere to any form of SemVer policy, allowing me to refactor them as I go.

In reality though, these parts of the internal codebase are unreachable unless somebody is doing something very wrong (which I hope they're not).

@ryangjchandler ryangjchandler merged commit 50ba183 into main Apr 11, 2025
2 of 3 checks passed
@ryangjchandler ryangjchandler deleted the refactors branch April 13, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant